﻿/****************************************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (http://rapidwebdev.org)
	Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@RapidWebDev.org

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************************************/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Security.Principal;
using System.Text;
using System.Web.Security;
using BaoJianSoft.Platform.Initialization;

namespace BaoJianSoft.Platform
{
	/// <summary>
	/// The interface is to populate all sitemap configurations for users.
	/// </summary>
	public interface ISiteMapApi
	{
		/// <summary>
		/// Returns the sitemap items visible to the user.
		/// The algorithm is to filter out sitemap items from the sitemap configuration file (or somewhere else) which the user doesn't have the permission. 
		/// </summary>
		/// <param name="userId"></param>
		/// <returns>Returns the sitemap items visible to the user.</returns>
		IEnumerable<SiteMapItemConfig> FindSiteMapConfig(Guid userId);
	}
}
